%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%                                                           %
% UniTerm Users Guide, Copyright 1986, 1987 Simon Poole     %
%                                                           %
% This file may not be changed without permission, all      %
% rights reserved.                                          %
%                                                           %
% Simon Poole                                               %
% Bahnhofstr. 51 b                                          %
% CH-5430 Wettingen                                         %
% Switzerland                                               %
%                                                           %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\chapter{Starting Using \UniTerm}\index{Starting Using \UniTerm} 
%
\section{Requirements}\index{Requirements}     
   To use \UniTerm\ you need:    
\begin{itemize}
\item     a ATARI ST computer 
\item     a monochrome or color monitor\index{monitor} 
\item     a RS232 standard cable 
\item     a computer/modem to connect to 
\item     a floppy disk containing \filen{UNITERM.PRG}\ and \filen{UNITERM.RSC} 
\end{itemize}



\section{Getting Started}\index{Getting Started}        


   After connecting  your  ST to your host computer, double click 
the  \UniTerm\  icon. If you  are  using \UniTerm\ for the first time 
an alert box will appear,   press  \mbox{\key{Return}\footnotemark}
\footnotetext{in  this manual \key{xx} 
means  the  the  key  with   xx   on   it,  \key{Alt}\  is  short  for 
\key{Alternate}} and  ignore the error message (\UniTerm\ didn't  find  
the   file   \filen{UNITERM.SET},  which we will create  later  on),  the 
screen  will  clear  to  white  (on  a monochrome monitor) with a 
statusline  on  line  25.    Press  \key{Help}\  and the \UniTerm\  help 
screen and a menu bar with following contents will appear:
\begin{center}
\begin{tabular}{|lllll|}
\hline
Desk~~~~~~~~~~~~ & File~~~~~~ & Transfer & Settings~~~~~ & Other~~~~~~~~~~~~~ \\
\hline 
\end{tabular}
\end{center}
         
\subsection{Desk Menu}\index{Desk Menu}
\begin{center}
\begin{tabular}{@{}l@{}llll@{}}
\hline
\vline Desk & File~~~~~~ & Transfer & Settings~~~~~ & Other~~~~~~~~~~~~~ \hfill\vline \\
\hline\vline 
About~Uniterm...\Rs      &          &               &       \\
\cline{1-1} \\
\end{tabular}
\end{center}


\noindent\button{Desk}\ is  the well known menu where you can  start  desk 
accessories  and with the \button{About UniTerm... }\  entry 
you can find out which version of \UniTerm\ you  are 
using.  

\subsection{File Menu}\index{File Menu}
\begin{center}
\begin{tabular}{@{}l@{}l@{}lll@{}}
\hline
\vline Desk~~~~~~~~~~~~ & File~~~~~~    &  Transfer & Settings~~~~~ & Other~~~~~~~~~~~~~ \hfill\vline \\
\hline                 \Ls Load Setup  \Rs          &           & \\
                       \Ls Save Setup  \Rs          &           &  \\
\cline{2-2}
                       \Ls Load Numbers \Rs         &           &  \\
                       \Ls Save Numbers \Rs         &           &  \\
\cline{2-2}
                       \Ls Show Space  \Rs          &           &  \\
                       \Ls Set Path    \Rs          &           &  \\
                       \Ls Delete File \Rs          &           &  \\
\cline{2-2}
                       \Ls Run Program \Rs          &           &  \\        
\cline{2-2}
                       \Ls Quit        \Rs          &           &  \\
\cline{2-2}
\end{tabular}
\end{center}


\noindent\button{File} allows you to select from: \\ 
\vspace{\smallskipamount}
\begin{tabular}{lp{3in}}
\button{Load Setup} &   load a previously saved setup from disk. \\ 
\button{Save Setup} &   save the current settings of \UniTerm\  to disk.\\
\button{Load Numbers} & load a setup file for the dialer \\
\button{Save Numbers} & save a setup file for the dialer \\  
\button{Delete File} &  delete a file. \\
\button{Set Path}    &  change  the current GEMDOS drive and  path. \\ 
\button{Show Space}  &  show total available and free  space  on the current drive. \\
\button{Run Program} &  execute  a program without leaving  \UniTerm. \\
\button{Quit Menu}   &  leave this screen and return to terminal mode. \\
\end{tabular}

\subsection{Transfer Menu}\index{Transfer Menu}

\begin{center}
\begin{tabular}{@{}ll@{}l@{}ll@{}}
\hline
\vline Desk~~~~~~~~~~~~ & File~~~~~~ & Transfer & Settings~~~~~ & Other~~~~~~~~~~~~~ \hfill\vline \\
\hline                  &           \Ls ASCII   \Rs         & \\
                        &           \Ls XModem  \Rs         &  \\
                        &           \Ls YModem  \Rs         &  \\
                        &           \Ls Kermit  \Rs         &  \\
\cline{3-3}
\end{tabular}
\end{center}


\noindent\button{Transfer}\ selects  the  file transfer protocol you  want  to 
use: A change here is reflected  in a different dialog  box  appearing
when  you select the \button{File Transfer}\ item in the \button{Settings}\ menu
and in the protocol used when you type \keytwo{Alt}{T}.   

\subsection{Settings Menu}\index{Settings Menu}


\begin{center}
\begin{tabular}{@{}lll@{}l@{}l@{}}
\hline
\vline Desk~~~~~~~~~~~~ & File~~~~~~ & Transfer~~ & Settings~~~~~ & Other~~~~~~~~~~~~~ \hfill\vline \\
\hline                  &            &         \Ls RS232         \Rs   \\
                        &            &         \Ls Terminal~1    \Rs    \\
                        &            &         \Ls Terminal~2    \Rs    \\
                        &            &         \Ls File~Transfer \Rs    \\
                        &            &         \Ls Graphics      \Rs    \\
                        &            &         \Ls Tabs          \Rs    \\
                        &            &         \Ls Buffers       \Rs    \\
\cline{4-4}
\end{tabular}
\end{center}

\noindent\button{Settings}\ allows you to select from: \\ 
\vspace{\smallskipamount}
\begin{tabular}{lp{3in}}
\button{RS232}         &  sets the parameters of the serial port. \\ 
\button{Terminal 1}    &  sets   the   value  of   some   terminal 
                        (text mode)  parameters. \\ 
\button{Terminal 2}    &  sets the rest of the terminal specific parameters\\
\button{Graphics}      & sets   the  values  for   the   graphics 
                       terminal  module of  \UniTerm. \\
\button{File Transfer} & allows you to set the parameters for the 
                       current file transfer mode. \\           
\button{Buffers}       & set  the  sizes of the  buffers  \UniTerm\ 
                       uses. \\
\button{Tabs}          & set the tab positions (do not change without
                         need, a lot of software depends on the
                         ``factory'' settings)\\
\end{tabular}

\subsection{Other Menu}\index{Other Menu}
      

\begin{center}
\begin{tabular}{@{}llll@{}l@{}}
\hline
\vline Desk~~~~~~~~~~~~ & File~~~~~~ & Transfer & Settings~~~~~ &  Other~~~~~~~~~~~~~ \hfill\vline \\
\hline                  &            &          &              \Ls Dialer             \hfill\vline   \\
                        &            &          &              \Ls Edit Function Keys \hfill\vline \\
\cline{5-5}
\end{tabular}
\end{center}

\noindent\button{Other}\ has two items:\\
\vspace{\smallskipamount}
\begin{tabular}{lp{3in}}
\button{Edit Function Keys} & allows  you  to assign a  string  and/or 
                            macro commands to a function key. \\    
\button{Dialer}  &      setup   the   dialling   sequences   and 
                        telephone numbers for your modem. \\
\end{tabular}



 Select the \button{RS232}\ item in the \button{Settings}\ menu and
a new dialog will appear.  Selecting  the  different values for the  
parameters  is quite straightforward,  just click on the buttons with 
the  right values (we  hope you know them,  otherwise you will just 
have  to experiment)  and  when you are finished select \button{OK}.  
To  save  the setup,  select \button{Save setup}\ from the \button{File}
menu, a normal GEM  file selector  dialog will appear,  if you want 
to use this  setup  as default,  save  it with the name 
\filen{UNITERM.SET} and  \UniTerm\  will load it automatically on 
startup. To leave the help screen select \button{Quit Menu}, 
press \key{Q}\ or the left mouse button once.   


 If you  have adjusted the parameters correctly,  you should  now 
be  able  to  communicate with your host computer. Some operating 
systems   (VMS)  try  to  identify  the  terminal  automatically, 
depending  on  your  setup  \UniTerm\ will identify itself as a DEC 
VT200,   VT102,  VT100  or  as  an  VT100  emulating  a  VT52.  A 
VT102/VT200  has more ``advanced'' editing functions (which results 
in  less  overhead  in  transmitting  inserts etc.) so leave this 
option  on  VT102/VT200  if  possible.  If  you have to enter the 
terminal  type  manually  try VT102 first (changing from VT102 to 
VT100  or  to VT200 only changes the report from \UniTerm, not the 
actual commands \UniTerm\ understands). 

\section{Exiting \UniTerm}\index{Exiting \UniTerm} 
       
 To stop \UniTerm, press the \key{Undo}\ key, an alertbox will appear asking for 
con\-fir\-ma\-tion\footnote{to avoid the alertbox, press \keytwo{Alt}{Undo}}.

  
\section{Vector Graphics Mode}\index{Vector Graphics Mode}      


  After  receiving  the  control  code  \ASCII{GS}\  (this can  be  turned 
off)   or  the 4105 command \ASCII{ESC}{\%}!0 (ASCII control characters  are 
printed in {\sf this font} to  distinguish  them  from  printable characters,   a  
space   is  written  \ASCII{SP})  from the host,  \UniTerm\ switches  to  a 
separate graphics screen,  if the host doesn't send \ASCII{ESC}\ASCII{FF}\   (the  
ASCII  characters  Escape  and  Formfeed) before starting  a  new  
picture,   you  will  have  to  clear the screen manually    with   
\keytwo{Alt}{F1}.   The  incoming  characters  will  be interpreted   as  
Tektronix  encoded  vectors  or  commands  (see appendix A) until 
\UniTerm\ receives one of the following codes: 
     
\begin{itemize}
\item \ASCII{CAN}     will return you to VT102 mode,
\item \ASCII{ESC}\ASCII{FF}   will  clear the screen and enter  Tektronix  alpha mode.       
\item \ASCII{ESC}{\%}!1   will return to VT102 mode.  
\end{itemize}

To  return manually from Tektronix to VT200/VT102/VT100/VT52 mode
press  \keytwo{Alt}{F6}\  or  select  the  appropriate mode from the item
Terminal  in the menu Settings.  To view your picture again press
\keytwo{Alt}{F5}.  Be  careful,  selecting Tektronix 4010 mode  manually 
will also reset the history buffer!  

\section{Zoom Mode}\index{Zoom Mode}        

 If your history buffer is large enough, you can redraw a picture 
with  different  scaling  factors.  To select  this  mode   press 
\keytwo{Alt}{F9},  the screen will be cleared,  the current contents  of 
the buffer will be drawn on the screen and the normal arrow mouse 
cursor will appear.  


  To select the region of the picture you want to  magnify,  move 
the  arrow to the upper left corner of the region, press the left 
mouse  button and drag the mouse to the lower right corner of the 
region  (a  ``rubber box'' should follow the arrow) and release the 
button.  The  resulting picture will be scaled so that the larger 
side  of box will fit on the screen (if the option True Aspect is 
selected).   You  can  repeat  this operation until a magnification
factor of thirty is reached.      


 \key{Backspace}\ will restore the previous scaling factor,  the arrow 
keys  will move the screen a third of the screen  width/height  in 
their direction,  \key{Return}\ will reset to the original scaling and 
\key{Undo}\  will leave zoom mode.  Remember that if your  picture  is 
built out a lot of vectors, the redrawing may take some time!

 
\section{GIN Mode}\index{GIN Mode}       


  The  sequence  \ASCII{ESC}\ASCII{SUB}\  will enter GIN mode  from  any  of  the 
Tektronix modes, it will not work from the VT102/VT100 mode since 
\ASCII{SUB}\  cancels  all ANSI type commands.  A  crosshair  cursor  will 
appear  which  can be moved with the mouse
\footnote{Moving the mouse to quick may cause the mouse handler 
to miss some interrupts, resulting in some rather odd behaviour 
of the cursor.}.  Pressing any key  on 
the keyboard  will cause a GIN report to be sent to the host  and 
exits  the GIN mode to Tektronix alpha mode (if for  some  reason 
the  program switching \UniTerm\ into GIN mode does not  stop,  you 
can exit completely by pressing \key{Undo}).  

\section{Tektronix 4014 Alpha Mode}\index{Tektronix 4014 Alpha Mode}

      
  This mode is only included for compatibility with the  GIN-mode 
and  is not very useful.  It is the same as 4010 alpha mode  with 
one  margin.  This  mode  will probably  be  replaced  in  future 
versions with a 4105 compatible alphamode.  

\section{Using the Special Keys}\index{Using the Special Keys}     


  Here  is  a list of the functions on the  special  keys  (press 
\key{Alt}\ and the key listed here to invoke the function): 

\begin{description}
\expkey{F1}{Erases  the  graphics screen and resets  the  Tektronix 
                   emulation   from   any   terminal   mode.}
\expkey{F2}{Toggle 24/49 lines mode (only on monochrome monitor).}
\expkey{F3}{Write history buffer contents to a VDI-device  (printer 
                   or meta-file).}  
\expkey{F4}{Prints  the contents of the textbuffer (this is a  very 
                   quick  way  of getting a copy of the  screen  contents, 
                   it is much faster than using the normal screen dump).}  
\expkey{F5}{Switches  to the graphics screen and sets the  terminal 
                   to  Tektronix 4010 mode.}        
\expkey{F6}{Switches  the  screen and the terminal  to  VT102/VT100 
                   mode.}        
\expkey{F7}{Resets  the  terminal,  reads the default  values  from 
                   disk.}       
\expkey{F8}{Toggle autoprint.}  
\expkey{F9}{Enter zoommode.}  
\expkey{F10}{Toggle between 132(128) and 80 column mode.}  
\expkey{A}{Send the answerback string.} 
\expkey{B}{Send a short break (0.233 s) (doesn't drop DTR).}  
\expkey{C}{Start/stop file capture.}  
\expkey{H}{Hangup the telephone.}
\expkey{L}{Send a long break (3.5 s) (drops DTR).}
\expkey{P}{Screen dump to disk in DEGAS\footnotemark\ format.}  
\expkey{R}{Playback a file with the terminal emulator.}  
\expkey{S}{Control history recording.}
\expkey{T}{Start  file  transfer (starts file  transfer  with  the 
                  protocol selected in the \button{Transfer}\ menu).} 
\expkey{V}{View the history buffer.} 
\expkey{X}{Save history buffer to disk.}
\expkey{Z}{Hold Screen (\key{Y}\ on the german keyboard).}  
\expkey{1--0}{Dial numbers 1 to 10.}
\expkey{Help}{Atari screen dump.}    
\expkey{Insert}{Start the single-line editor.}
\expkey{CapsLock}{Toggle Meta mode.}\index{Meta mode}  
\end{description}
\footnotetext{DEGAS is a trademark of Batteries Included Inc.}

\section{The Clipboard}

Pressing the left mouse button while the I-type mouse cursor is 
visible\footnote{If it is not visible, move the mouse a bit}
will produce a ``rubber box'', after you have let go of the 
mouse button the selected text will be inverted and a small popup
menu will appear:

\begin{itemize}
\item clicking outside the popup will cancel the operation,
\item selecting the \button{Cut}\ item with the left mouse button
      will store the text in a  buffer (the ``clipboard''). Doing the 
      same with the right button will append a \ASCII{CR}\ after each line,
\item \button{Add}\ appends to the text already in the clipboard
       (with the same difference between left and right mouse button), 
\item \button{Send}\ sends the text directly to the host computer\footnotemark,
       without using the clipboard (same usage of left and right button).
\end{itemize}
\footnotetext{The delay between the cursor key codes can be set with 
the ``Delay'' parameter in the ``ASCII File Transfer'' dialog}

Two commands supplement this feature, {\tt SaveClip} and {\tt Insert} which
are available via the main popup menu:

\begin{itemize}
\item {\tt SaveClip} allows you to save the contents of the clipboard to
      a file, \ASCII{CR}'s are mapped to \ASCII{CR}\ASCII{LF}. 
\item {\tt Insert} sends the contents of the clipboard to the host computer.
\end{itemize}

Additional operations on the clipboard are possible with seperate programs,
the clipboard can be accessed via the \UniTerm\ parameter block, example programs
and documentation should be available with this manual.

\section{Mouse Cursor Control}\index{Mouse Cursor Control}

In practically all situations where you can use the cursor  keys, 
you can use the mouse to position the cursor too;  while the mouse
cursor is visible 
(the I-type text cursor) move it to  the  new position and  
double click the left mouse button;  the cursor should now  move 
to the new position\footnote{The delay between the cursor key codes
can be set with the ``Delay'' parameter}.  Some editors do not 
allow you to  move the cursor over tabs, this will cause the cursor 
to miss the intended end position in some cases. 

\section{Popup Menu}\index{Popup Menu}

Besides  being  bound to keys some  functions  of  \UniTerm\  are 
accessible via a popup menu\footnote{The default configuration
can be changed with the macro command REASSIGN}. Click the 
right mouse button (while the mouse cursor is visible) and the  
popup will appear at the current cursor position. To select one 
of the  items  just click the left button,  to get rid of  the  
menu click outside of the popup area. The default configuration
assigns the ten telephone numbers of the dialer to the fields
on the right-hand side.

\section{Viewing the History Buffer}

You can view the contents of the history buffer with the key combination
\keytwo{Alt}{V}\footnote{You must reserve at least 25kB of system memory
for this to work, the memory will only be used as long as the view mode
is active}. Besides the normal `clip' functions with the mouse, six keys
have a special function:
\begin{tabbing}
MMMM\=MMMMMMMMMMMMM\=MMM\kill
    \> \key{Undo}    \> Exit.\\
    \> \key{Insert}  \> Bottom of buffer.\\
    \> \key{ClrHome} \> Top of buffer. \\
    \> \key{\Uarrow} \> Up one line. \\
    \> \key{\Darrow} \> Down one line. \\
    \> \key{\Rarrow} \> Up one page.\\
    \> \key{\Larrow} \> Down one page.\\
\end{tabbing}

\section{Dialer}\index{Dialer}

 The setup file \filen{UNITERM.TEL} is loaded at startup,  if it  isn't 
found the values for the dialer are reset.  The keys \keytwo{Alt}{1}\  to 
\keytwo{Alt}{0}\ dial numbers 1 to 10, \keytwo{Alt}{H}\ sends the hangup string. 

 A ``+'' as first character of the number is a placeholder for  the 
access code. Dialling can be aborted by pressing \keytwo{Control}{C}, the 
timeout is 40 seconds.

  The suffix,  prefix and hangup strings are passed to the  macro 
interpreter in ``function-key''\footnote{This means characters between 
the macro commands are sent aswell} mode.
  
If the number and macro field is emtpy, the dialer returns straight
away, if the number field is empty and a macro file is specified,
the macro file is executed.

A tip for people that want the macro to handle waiting for the \mbox{``CONNECT''}
or whatever it may be message, just leave out the ``Connect msg'' entry. The
dialer will then immediatly start executing the macro file after sending the number 
string.

\section{Meta Mode}\index{Meta Mode}

In Meta mode \key{Alternate}\ is the so called Meta key\index{Meta key};
pressing \key{Alternate}\ plus a second key will produce the ASCII code
of that letter plus 128 (the Meta key sets the eighth bit of the character).
To enter Meta mode press \keytwo{Alt}{CapsLock}\ (this will toggle an
indicator on the statusline).

Some of the more important characters of the international character set
\index{international character set}that can be generated are:  
 
\begin{center}
\begin{tabular}{|c|c|c|c|}
\hline
\key{Meta}+ & Character & \key{Meta}+ & Character \\
\hline
\key{@} &  \`{A}        & \key{`}     & \`{a}     \\ 
\key{A} &  \'{A}        & \key{a}     & \'{a}     \\
\key{B} &  \^{A}        & \key{b}     & \^{a}     \\
\key{C} &  \~{A}        & \key{c}     & \~{a}     \\
\key{D} &  \"{A}        & \key{d}     & \"{a}     \\
\key{E} &  \.{A}        & \key{e}     & \.{a}     \\
\key{F} &  \AE          & \key{f}     & \ae       \\
\key{G} &  \c{C}        & \key{g}     & \c{c}     \\
\key{H} &  \`{E}        & \key{h}     & \`{e}     \\
\key{I} &  \'{E}        & \key{i}     & \'{e}     \\
\key{J} &  \^{E}        & \key{j}     & \^{e}     \\
\key{K} &  \"{E}        & \key{k}     & \"{e}     \\
\key{L} &  \`{I}        & \key{l}     & \`{i}     \\
\key{M} &  \'{I}        & \key{m}     & \'{i}     \\
\key{N} &  \^{I}        & \key{n}     & \^{i}     \\
\key{O} &  \"{I}        & \key{o}     & \"{i}     \\
\key{Q} &  \~{N}        & \key{q}     & \~{n}     \\
\key{R} &  \`{O}        & \key{r}     & \`{o}     \\ 
\key{S} &  \'{O}        & \key{s}     & \'{o}     \\
\key{T} &  \^{O}        & \key{t}     & \^{o}     \\
\key{U} &  \~{O}        & \key{u}     & \~{o}     \\
\key{V} &  \"{O}        & \key{v}     & \"{o}     \\
\key{W} &  \OE          & \key{w}     & \oe       \\
\key{X} &  \O           & \key{x}     & \o        \\
\key{Y} &  \`{E}        & \key{y}     & \`{e}     \\
\key{Z} &  \'{E}        & \key{z}     & \'{e}     \\
\key{[} &  \^{E}        & \key{\{}    & \^{e}     \\
\key{\Bslash} &  \"{E}  & \key{\Vbar} & \"{e}     \\
\key{]} &  \"{Y}        & \key{\}}    & \"{y}     \\
\key{\_} &  \ss         &             &           \\
\hline
\end{tabular}
\end{center}

If you have a non-US keyboard, you will probably have to
edit your \UniTerm\ setup file with KeyEdit\index{KeyEdit}\ to
get all ASCII codes\footnote{typically \{ ,\} ,[ and ] are missing}.
